Author: N.F.S Grundtvig (The members of this class inherits the author by default.)
How to include an example.
How to include an example.
Use:
\example relative_path_to_file_name
. Alternatively if the file is
not found relative to the current directory, then the path is considered to
be relative to the example path set in DoxySFile (EXAMPLE_PATH). That is, the example is looked for here:
EXAMPLE_PATH/relative_path_to_file_name
Inline formatted code in place
Examples are
always put into the "example" section, which is at the end of the generated documentation page for the entity. In case you want to inline
formatted code directly in in the documentation refer to
InlineFormattedCode.
This is how it looks in the source:
\example examples/myexample.cpp
|